| Description | : Get a single commercial Marketplace public product. |
| Reference | : Link ¶ |
⚶ Changes
{
"#id": "Products_Get",
"Summary": {
"new": "Get a single commercial Marketplace public product.",
"old": "Single Public Product API provides an unauthenticated endpoint for consuming product attributes of a single commercial 3rd party Marketplace public product or 1st party Azure product. Each API request must include an API key allocated to you. Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)"
}
}
⚼ Request
GET:
/products/{id}
{
id:
string
,
market:
string
,
api-version:
string
,
language:
string
,
locations:
array
,
includeStopSoldPlans:
boolean
,
hideKeys:
array
,
excludeSkuDetails:
boolean
,
includeFutureAvailabilities:
boolean
,
skuId:
string
,
x-ms-pricing-audience:
string
,
X-API-Key:
string
,
}
⚐ Response (200)
{
displayName:
string
,
popularity:
number
,
categoryIds:
[
,
string
,
]
industryIds:
[
,
string
,
]
publisherId:
string
,
azureBenefit:
string
,
badges:
[
,
string
,
]
publisherType:
string
,
publishingStage:
string
,
uniqueProductId:
string
,
productType:
string
,
productSubType:
string
,
productFamily:
string
,
operatingSystems:
[
,
string
,
]
pricingTypes:
[
,
string
,
]
publisherDisplayName:
string
,
longSummary:
string
,
summary:
string
,
linkedAddInsTypes:
object
,
smallIconUri:
string
,
description:
string
,
ratingBuckets:
[
,
string
,
]
ratingAverage:
number
,
ratingCount:
integer
,
startingPrice:
string
,
plans:
[
]
,
{
,
planId:
string
,
uniquePlanId:
string
,
displayName:
string
,
vmArchitectureType:
string
,
cspState:
string
,
metadata:
string
,
altStackReference:
string
,
stackType:
string
,
altArchitectureReference:
string
,
categoryIds:
[
,
string
,
]
hasProtectedArtifacts:
boolean
,
pricingTypes:
[
,
string
,
]
vmSecuritytypes:
[
,
string
,
]
summary:
string
,
description:
string
,
skuId:
string
,
planType:
string
,
displayRank:
string
,
isPrivate:
boolean
,
id:
string
,
availabilities:
[
]
,
{
,
id:
string
,
actions:
[
,
string
,
]
meter:
string
,
pricingAudience:
string
,
terms:
[
]
,
{
,
termDescriptionParameters:
[
]
,
{
,
parameter:
string
,
value:
string
,
}
termId:
string
,
termUnit:
string
,
prorationPolicy:
string
,
termDescription:
string
,
price:
string
,
renewTermId:
string
,
renewTermUnits:
string
,
billingPlan:
string
,
renewToTermBillingPlan:
string
,
isAutorenewable:
boolean
,
}
hasFreeTrials:
boolean
,
consumptionUnitType:
string
,
displayRank:
integer
,
}
uiDefinitionUri:
string
,
artifacts:
[
]
,
{
,
name:
string
,
uri:
string
,
artifactType:
string
,
}
version:
string
,
isHidden:
boolean
,
isStopSell:
boolean
,
stopSellInfo:
string
,
minQuantity:
integer
,
maxQuantity:
integer
,
isQuantifiable:
boolean
,
billingComponents:
[
]
,
{
,
billingTag:
string
,
customMeterIds:
object
,
}
purchaseDurationDiscounts:
[
]
,
{
,
duration:
string
,
discountPercentage:
number
,
}
isHiddenPrivateOffer:
boolean
,
certifications:
[
]
,
{
,
id:
string
,
displayName:
string
,
uri:
string
,
}
customerInstruction:
string
,
planLabels:
[
,
string
,
]
skuType:
string
,
skuTitle:
string
,
location:
string
,
armRegionName:
string
,
cloud:
string
,
locationType:
string
,
region:
string
,
skuGroupId:
string
,
zone:
string
,
feature:
string
,
serviceType:
string
,
skuAttributes:
[
]
,
{
,
key:
string
,
value:
string
,
}
skuProperties:
string
,
offeringProperties:
}
[
]
,
{
,
productCode:
string
,
termId:
string
,
meterType:
string
,
billingMeterId:
string
,
offeringId:
string
,
type:
string
,
}
supportedProducts:
[
,
string
,
]
applicableProducts:
[
,
string
,
]
lastModifiedDateTime:
string
,
locations:
[
,
string
,
]
serviceFamily:
string
,
service:
string
,
productId:
string
,
hasMarketplaceFootprint:
boolean
,
attributes:
[
]
,
{
,
key:
string
,
value:
string
,
}
language:
string
,
hasStandardContractAmendments:
boolean
,
offerId:
string
,
standardContractAmendmentsRevisionId:
string
,
universalAmendmentUrl:
string
,
isPrivate:
boolean
,
isStopSell:
boolean
,
stopSellInfo:
string
,
marketingMaterial:
string
,
legalTermsUri:
string
,
cspLegalTermsUri:
string
,
legalTermsType:
string
,
privacyPolicyUri:
string
,
supportUri:
string
,
uiDefinitionUri:
string
,
screenshotUris:
[
,
string
,
]
links:
[
]
,
{
,
id:
string
,
displayName:
string
,
uri:
string
,
}
linkedAddIns:
[
,
string
,
]
mediumIconUri:
string
,
largeIconUri:
string
,
wideIconUri:
string
,
images:
[
]
,
{
,
context:
string
,
items:
}
[
]
,
{
,
id:
string
,
uri:
string
,
type:
string
,
}
artifacts:
[
]
,
{
,
name:
string
,
uri:
string
,
artifactType:
string
,
}
videos:
[
]
,
{
,
caption:
string
,
uri:
string
,
videoPurpose:
string
,
previewImage:
string
,
}
additionalProductProperties:
object
,
pricingDetailsUri:
string
,
isReseller:
boolean
,
productOwnershipSellingMotion:
string
,
disableSendEmailOnPurchase:
boolean
,
isCoreVm:
boolean
,
}
⚐ Response (default)
{
$headers:
{
,
x-ms-error-code:
string
,
}
$schema:
}
{
,
error:
}
{
,
code:
string
,
message:
string
,
}